Update documentation
Daniel O'Connor
1 changed files with 18 additions and 3 deletions
+ 18
- 3
app/models/agents/google_calendar_publish_agent.rb
@@ -28,11 +28,15 @@ module Agents |
||
| 28 | 28 |
|
| 29 | 29 |
`calendar_id` - The id the calendar you want to publish to. Typically your google account email address. |
| 30 | 30 |
|
| 31 |
- `service_account_email` - The authorised service account. |
|
| 31 |
+ `google` A hash of configuration options for the agent. |
|
| 32 | 32 |
|
| 33 |
- `key_file` - The path to the key file. |
|
| 33 |
+ `google` `service_account_email` - The authorised service account. |
|
| 34 | 34 |
|
| 35 |
- `key_secret` - The secret for the key, typically 'notasecret' |
|
| 35 |
+ `google` `key_file` - The path to the key file. |
|
| 36 |
+ |
|
| 37 |
+ `google` `key_secret` - The secret for the key, typically 'notasecret' |
|
| 38 |
+ |
|
| 39 |
+ `details` A hash of event details. See https://developers.google.com/google-apps/calendar/v3/reference/events/insert |
|
| 36 | 40 |
|
| 37 | 41 |
|
| 38 | 42 |
Set `expected_update_period_in_days` to the maximum amount of time that you'd expect to pass between Events being created by this Agent. |
@@ -55,6 +59,17 @@ module Agents |
||
| 55 | 59 |
'key_file' => '/path/to/private.key' |
| 56 | 60 |
'key_secret' => 'notasecret', |
| 57 | 61 |
'service_account_email' => '' |
| 62 |
+ }, |
|
| 63 |
+ 'details' => {
|
|
| 64 |
+ 'visibility' => 'default', |
|
| 65 |
+ 'summary' => "Awesome event", |
|
| 66 |
+ 'description' => "An example event with {{text}}. Pro tip: DateTimes are in RFC3339",
|
|
| 67 |
+ 'start': {
|
|
| 68 |
+ 'dateTime': '2014-10-02T10:00:00-05:00' |
|
| 69 |
+ }, |
|
| 70 |
+ 'end': {
|
|
| 71 |
+ 'dateTime': '2014-10-02T11:00:00-05:00' |
|
| 72 |
+ } |
|
| 58 | 73 |
} |
| 59 | 74 |
} |
| 60 | 75 |
end |